home *** CD-ROM | disk | FTP | other *** search
/ CD Actual Thematic 29 / CDT29.iso / e-Mail / WorldClient Pro 2.2.3 / wcsetup.exe / README.TXT < prev    next >
Encoding:
Text File  |  2000-09-14  |  9.1 KB  |  205 lines
  1. --------------------------------------------------------------------------
  2.                  WorldClient Pro 2.0 Readme File
  3. --------------------------------------------------------------------------
  4.  
  5. SYSTEM REQUIREMENTS
  6. -------------------
  7. WorldClient Pro is a multi-threaded Win32 application that runs as a
  8. system service on Windows 95/98 and NT 4 or later and requires an SMTP
  9. server for outgoing mail.  
  10.  
  11. The amount of required system resources is contingent upon your particular
  12. needs: your number of WorldClient Pro users, the level of email traffic
  13. you wish to support, the speed of your connection, and so forth.  However,
  14. we recommend at least a Pentium class computer with 16 MB RAM as a 
  15. starting point.
  16.  
  17. INSTALLATION
  18. ------------
  19. There are three things that you will need to know during the installation
  20. process:
  21.  
  22.   o Your Name and Company, and e-mail address.
  23.   o The host name or IP address of the SMTP server that will be used for
  24.     outgoing mail.
  25.   o The host name of the POP server that you wish to display by default in
  26.     the "POP Server" box seen by users when creating new mailboxes.
  27.  
  28. GENERAL
  29. -------
  30. The WorldClient mail system is comprised of several distinct componants.
  31. These include the WorldClient Server which runs as a system service and is
  32. the actual web server agent performing all the web and email i/o with
  33. browsers and mail servers.  Also, the WorldClient Admin Server runs as a
  34. service as well and manages connections by browsers wishing to remotely
  35. configure the WorldClient mail system.  Additionally, an Administration
  36. GUI application is included that can start and stop either service.  You
  37. may also start and stop either service via the services applet from the
  38. Windows control panel or via the command line with the NET util.
  39.  
  40. DEFAULTS
  41. --------
  42.  
  43.   o The WorldClient Server listens on port 2000 for all local IP's.
  44.   o The WorldClient Admin Server listens on port 2001 for all local IP's.
  45.   o Both services bind their listening sockets to all local IP addresses
  46.     by default.
  47.   o The default logon and password for gaining access to the WorldClient
  48.     Admin Server are 'Admin' and 'WorldClient' respectively.  These
  49.     parameters are case sensitive, and are contained in the WorldClient.ini
  50.     file.  They can also be changed from within the WorldClient Admin GUI
  51.     after you have logged in.  You should change these credentials ASAP.
  52.  
  53. If you wish to change the ports or bind to a specific IP address, you can do
  54. so by editing the WorldClient.ini located in the WorldClient directory.  To
  55. bind to a specific IP address, change the BindAddress key in the WebServer
  56. section to the IP address to which you wish to bind WorldClient. The default
  57. value of 0.0.0.0 will bind to all local interfaces.  You will have to stop
  58. & restart the WorldClient Server service in order for these changes to take
  59. effect.
  60.  
  61. NOTE: The port and binding settings (and all other *.ini settings) can also
  62. be edited by accessing the WorldClient Admin Server.
  63.  
  64. DIRECTORIES & FILES
  65. -------------------
  66. \WorldClient\
  67. Besides WorldClient's main application files, the base directory contains
  68. several files that you may need to work with:
  69.  
  70.   o WorldClient.ini - All non user-specific settings for the WorldClient
  71.     Server and the WorldClient Admin Server are stored in this file.  This
  72.     file also contains the default settings for new users.  User specific
  73.     settings are found in the USER.INI files located within a particular
  74.     user's mail directory.  The name of this directory is the same as the
  75.     user's login name, and is located in the \Users\ subdirectory.
  76.  
  77.   o AddrBook.txt - This is the file used for building WorldClient's Global
  78.     Address Book.  Personal Address Book entries are built from the
  79.     AddrBook.txt file that is located in each user's personal mail
  80.     directory.
  81.      
  82.     NOTE: These files are TAB delimited.  To add an Address Book entry,
  83.     type: Full Name[Tab]email address[Tab][Return].  The entry will not be
  84.     recognized unless there are tabs before and after the email address.
  85.  
  86. \Admin-CGI\
  87. This subdirectory is where you should store CGI's that you wish to use
  88. with the WorldClient Admin Server.
  89.  
  90. \HTML\
  91. The HTML subdirectory is where any image files that are referred to by
  92. WorldClient are stored.  Here, you should also store any HTML files that you
  93. have created and wish to incorporate into your WorldClient site.  These can
  94. be referenced as relative links with or without a leading "/" within
  95. WorldClient's template files.
  96.  
  97. \Logs\
  98. The Logs subdirectory contains five log files that WorldClient
  99. maintains:
  100.  
  101.   o HTTP.LOG - This log is a CLF (Common Log Format) compliant http request
  102.     log use by the WorldClient Server.  You can parse this log with any
  103.     popular web statistics software to see access statistics to your
  104.     WorldClient site.
  105.  
  106.     In the future, this we will also support ELF (Extended Log Format),
  107.     which includes the agent & referrer information.
  108.  
  109.   o HTTP-ADMIN.LOG - This log file is the same as the HTTP.LOG except that
  110.     it is used for the WorldClient Admin Service.
  111.  
  112.   o WDAEMON.LOG - This file contains low-level human readable logging of
  113.     transactions made thru the WorldClient Server's web-server engine.
  114.  
  115.   o WDAEMON-ADMIN.LOG - This is the same as the WDAEMON.LOG except that it
  116.     is for WorldClient Admin Server's web-server engine.
  117.  
  118.   o WORLDCLIENT.LOG - This file contains detailed logging of all
  119.     WorldClient activity.  In the WorldClient.ini you can specify the
  120.     level of log file verbosity by designating a value of 1 through 4;
  121.     1 being the most verbose and 4 being the least.
  122.  
  123. \Users\
  124. The USERS directory servers as the root from which each account's mail dir
  125. stems.  A user's mail directory may contain:
  126.  
  127.   o The user's mail folders, which contain the user's messages.
  128.   o The user's personal AddrBook.txt.
  129.   o One or more .SIG files which contain signatures on a per mailbox basis.
  130.   o Dictionary.txt - Contains user added words that the spell checker
  131.     should skip over during spell checking.
  132.   o USER.INI - This file contains the user's personalized settings.
  133.  
  134. \Utils\
  135. The utils directory contains several utilities we have provided for use with
  136. WorldClient.  These include:
  137.  
  138.   o ImportMD.exe  - for importing MDaemon user accounts into WorldClient.
  139.   o ImportNT.exe  - for importing your NT SAM database into WorldClient.
  140.   o ImportTXT.exe - for importing accounts from a text file.
  141.   o MDAddUser.zip - for automatically creating MDaemon user accounts when
  142.                     a WorldClient account is created.
  143.  
  144. \Templates\
  145. The Templates subdirectory is where all of the html templates used by the
  146. WorldClient parsing engine are stored.  These templates are read in and
  147. all variables, denoted by <$varname$>, are replaced by WorldClient on the
  148. fly and then sent to the browser.  Templates also contain references to
  149. language specific data stored in the LANGUAGES.INI file which is located
  150. here.  Language strings are denoted within the templates as [$Text$] and
  151. are always provided in English within the templates.  When another language
  152. is being used the english text within the template is replaced with a
  153. match taken from the LANGUAGES.INI file.
  154.  
  155. Different templates can be grouped together as a "theme" if needed to
  156. embrace a wider range of browser support.  WorldClient ships with one theme:
  157. jsFrames (Frames with JaveScript).  If you wish to create another theme for
  158. your users to choose from then you should place it in the same subdirectory
  159. as the jsFrames directory - "...\WorldClient\Templates\[yourTheme dir]".  If
  160. you wish to customize WorldClient's look, the HTML files in the themes
  161. directories are what you must edit.
  162.  
  163. NOTE: Make sure that you backup the templates before you experiment, and be
  164. careful not to remove any mandatory tags or you will get unexpected results.
  165.  
  166. See the Administrator's Help for a information regarding customizing
  167. WorldClient, and for a list of Template Tags and their functions.
  168.  
  169. WORLDCLIENT ADMIN SERVER
  170. ------------------------
  171. To access the WorldClient Admin Server go to port 2001 (default) of your
  172. WorldClient Server.
  173.  
  174.    Example:  http://www.mycompany.com:2001
  175.  
  176. When you connect to the Admin Server interface from a remote location, you
  177. will be asked to login.  The case-sensitive default parameters for login are:
  178.  
  179.                User Name - Admin
  180.                Password  - WorldClient
  181.  
  182. You can use the Remote Administration interface to:
  183.  
  184.   o Restart the WorldClient service.
  185.   o Monitor and/or Kill the active sessions.
  186.   o Monitor session statistics.
  187.   o Edit the WorldClient.ini settings.
  188.   o Edit individual user settings.
  189.   o Delete users.
  190.   o Disable/Enable a user's account.
  191.   o View the WorldClient log.
  192.  
  193.  
  194. WORLDCLIENT ADMINISTRATION GUI APPLICATION
  195. ------------------------------------------
  196. This GUI application can be used to:
  197.  
  198.   o Start and stop the WorldClient service
  199.   o Monitor the active sessions.
  200.   o View individual user statistics.
  201.   o View, Print, Save, or Delete the most recent WorldClient log activity.
  202.   o Open the Remote Administration interface locally for editing WorldClient
  203.     and/or user settings.
  204.  
  205.